home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / fmqt131u.zip / FMQUOTE.DOC < prev    next >
Text File  |  1993-03-06  |  15KB  |  473 lines
  1.         
  2.         
  3.         
  4.         
  5.          ┌─────────────────────────────────────────────────────────────┐
  6.          │                                                             │
  7.          │ F   M   Q   u   o   t   e                                   │
  8.          │ ─────────────────────────   Version 1.31   ( March 6 1993 ) │
  9.          │                                                             │
  10.          │                                                             │
  11.          │                 The *first* Italian Quoter                  │
  12.          │                                                             │
  13.          │       Written by Alberto Quario [ 2:331/316.5@fidonet ]     │
  14.          │                                                             │
  15.          └─────────────────────────────────────────────────────────────┘
  16.         
  17.         
  18.         What do  you miss most ?  No no... let alone  Claudia Schiffel, I
  19.         was referring to FM, the FrontDoor Message Editor.
  20.         Do you  miss the 'GoldEd  style' quoting, the  random headers and
  21.         Origins ( even  different from area to area ) ?  If so FMQuote is
  22.         just for you !
  23.         
  24.         FMQuote is very fast and very easy to configure.
  25.         
  26.         FMQuote  configuration file  ( FMQUOTE.CFG )  is  searched in the
  27.         current  directory or  in that  one specified  by the environment
  28.         variable  FD.  Furthermore  it  is  possible  to supply a working
  29.         directory,  where  you'll  put  configuration/origin/header/index
  30.         files, with the environment variable FMQT.
  31.         For instance:
  32.         
  33.         SET FMQT=c:\fd\fmquote
  34.         
  35.         If you  supply an absolute path  for the Origin or  Header files,
  36.         the FMQT directory will be ignored.
  37.         
  38.         
  39.         Now you need to configure the  program. Create an ascii text file
  40.         and call  it FMQUOTE.CFG. Now,  one by line,  you can insert  the
  41.         parameters;  the  order  and  the  use  of uppercase or lowercase
  42.         doesn't matter. The  lines that begin with a  ';' will be treated
  43.         as comments and  ignored. In the FMQuote zipfile  you should have
  44.         found a configuration file with all the available parameters.
  45.         It's also present a program  (GENCFG.EXE) that helps to configure
  46.         the  quoter  and  updates  previous  configurations  that  may be
  47.         present. Please read the GENCFG.DOC file, too.
  48.         
  49.         
  50.         Let's now take  a look to the available  parameters, that will be
  51.         always written inside a rectangle.
  52.         
  53.         First of all it's necessary to define:
  54.         
  55.         ┌───────────────────┐
  56.         │ MsgFile  filename │
  57.         └───────────────────┘
  58.         
  59.         FMQuote Version 1.31                                      Page  1
  60.                  
  61.         
  62.         
  63.         
  64.         where <filename> is  the file in which we'll  save the message we
  65.         want to quote.
  66.         
  67.         I advice you to  use 'v' as filename, being  Alt+V the FM command
  68.         to save a message on disk, that is:
  69.         
  70.         ;
  71.         MsgFile  v
  72.         ;
  73.         
  74.         
  75.         If you want to generate the Origins is necessary to add
  76.         
  77.         ┌─────────────────────┐
  78.         │ NetAddr  z:n/f/(.p) │
  79.         └─────────────────────┘
  80.         
  81.         that  is the  network address  and if  you use  GEcho or  another
  82.         tosser/scanner that always insert its tearline you should add
  83.         
  84.         ┌──────────┐
  85.         │ NoTearLn │
  86.         └──────────┘
  87.         
  88.         to avoid problems.
  89.         
  90.         Who isn't interested in the Origins can exclude them with
  91.         
  92.         ┌──────────┐
  93.         │ NoOrigin │
  94.         └──────────┘
  95.         
  96.         
  97.         One of  the main FMQuote 1.31 changes is the ability  to generate
  98.         random Origins, and Headers as  well, reading them from an extern
  99.         file.
  100.         The file must be an ascii text file in which, one by line, we can
  101.         write our personal Origins.The parameter to specify that file is:
  102.         
  103.         ┌──────────────────┐
  104.         │ OriginF filename │
  105.         └──────────────────┘
  106.         
  107.         The maximum Origin length depends  on the network address length,
  108.         usually is between 55 and 60 characters.
  109.         
  110.         
  111.         
  112.         What we  said about Origins holds  for Headers, too. I  call them
  113.         'HiMsgs' and they  are printed   in the  beginning of  the quoted
  114.         message.
  115.         
  116.         
  117.         
  118.         FMQuote Version 1.31                                      Page  2
  119.                  
  120.         
  121.         
  122.         
  123.         In the <filename> specified in
  124.         
  125.         ┌──────────────────┐
  126.         │ HiMsgF  filename │
  127.         └──────────────────┘
  128.         
  129.         we'll put the headers for the general messages and in
  130.         
  131.         ┌─────────────────────┐
  132.         │ HiMsg2MeF  filename │
  133.         └─────────────────────┘
  134.         
  135.         the headers for the personal messages (those addressed to us).
  136.         
  137.         The HiMsgs maximum length is 255 characters.
  138.         
  139.         There are some macros available:
  140.         
  141.             %b  whole name of the person who wrote the quoted message
  142.             %B  name only  "   "   "  "   "   " "   "   "  "   "  "
  143.             %t  whole name of the person who received the quoted message
  144.             %d  whole message date
  145.             %g  only the day in numbers
  146.             %m  only the month in numbers
  147.             %M  only the month in letters
  148.             %a  only the year
  149.             %w  only the day of the week
  150.             %i  network address of the person who wrote the quoted
  151.                 message
  152.             %s  subject of the quoted message
  153.             %n  newline character
  154.             %%  '%' character
  155.         
  156.         For example to print:
  157.         
  158.         "Hi Mike Smith! On April 12 1992 you wrote..."
  159.         
  160.         I should add  a line in the  HiMsgF file as follow:
  161.         
  162.         Hi %b! On %d you wrote...
  163.         
  164.         To use HiMsg2MeF is necessary to add this parameter:
  165.         
  166.         ┌──────────────┐
  167.         │ MyName  name │
  168.         └──────────────┘
  169.         
  170.         For example I should write:
  171.         
  172.         ;
  173.         MyName Alberto_Quario
  174.         ;
  175.         
  176.         
  177.         FMQuote Version 1.31                                      Page  3
  178.                  
  179.         
  180.         
  181.         
  182.                                I M P O R T A N T
  183.                                ──────────────────
  184.         
  185.         To separate the name and the  surname you must use the underscore
  186.         character '_' !
  187.         
  188.         
  189.         We can define different Origins and Header for every echo area in
  190.         this way:
  191.         
  192.         @AREA_TAG
  193.         line 1
  194.         ......
  195.         line n
  196.         
  197.                                I M P O R T A N T
  198.                                ─────────────────
  199.         
  200.         If the  Headers/Origin file begins with  an area definition, that
  201.         is if  the ** FIRST **  line will be @SOME_AREA_TAG  then FMQuote
  202.         will  interpret that  file as  divided into  areas. Otherwise the
  203.         Headers/Origins will be chosen between all the lines.
  204.         
  205.         For example my Origin file could be:
  206.         
  207.         @CLANG
  208.         Origin 1 for CLANG echo area
  209.         Origin 2 for CLANG echo area
  210.         @COMMS
  211.         Origin for COMMS echo area
  212.         
  213.         
  214.         If  you don't  want to  specify  all  the areas  you can  use the
  215.         DEFAULT tag:
  216.         
  217.         @DEFAULT
  218.         Default Origin for the other echo areas
  219.         
  220.         
  221.         A maximum of 200 areas can be defined.
  222.         
  223.         
  224.         To make things work you have to supply the message base directory
  225.         with this parameter:
  226.         
  227.         ┌──────────────┐
  228.         │ MsgBDir  dir │
  229.         └──────────────┘
  230.         
  231.         for example
  232.         
  233.         MsgBDir  c:\fd\msgbase.
  234.         
  235.         
  236.         FMQuote Version 1.31